home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 019a / phidx13.zip / PHINDEX.DOC next >
Text File  |  1991-09-22  |  46KB  |  1,138 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.          ______________________________________________________________
  9.         |                                                              |
  10.         |                          - PhINDEX -                         |
  11.         |______________________________________________________________|
  12.  
  13.                         Text file Index word list utility
  14.  
  15.                                   Version  1.3
  16.                                 Released 08-24-91
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.                 COPYRIGHT 1991 Phil Herron.  ALL RIGHTS RESERVED
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                                  Herron Software
  46.                                   P.O. Box 1288
  47.                       Battle Ground, Washington  USA  98604
  48.  
  49.                                                                 PhIndex-ii
  50.  
  51.              TABLE OF CONTENTS                                  PAGE
  52.         ________________________________________________________________
  53.  
  54.              Preface......................................... Pref-1
  55.  
  56.              New in this version.................................. 1
  57.              Introduction......................................... 1
  58.              Overview............................................. 1
  59.              System Requirements.................................. 2
  60.              Installing........................................... 2
  61.              Help................................................. 2
  62.  
  63.              Syntax............................................... 3
  64.              Examples............................................. 3
  65.              Operating Screen..................................... 4
  66.              Noise words.......................................... 4
  67.              Execution speeds..................................... 4
  68.  
  69.              Index Procedure...................................... 5
  70.              Sample Run........................................... 6
  71.                Interim result..................................... 7
  72.                Final result....................................... 8
  73.  
  74.              DOS ErrorLevel....................................... 9
  75.              Version History...................................... 9
  76.  
  77.              Support............................................ A-1
  78.                Problem Resolution............................... A-1
  79.                Reporting A Problem.............................. A-1
  80.                Custom Modifications............................. A-2
  81.                Correspondence................................... A-2
  82.  
  83.              Index.............................................. I-1
  84.  
  85.  
  86.                                                                     Pref-1
  87.  
  88.  
  89.                  ______________________________________________
  90.  
  91.                              DISCLAIMER OF WARRANTY
  92.                  ______________________________________________
  93.  
  94.  
  95.                  THIS PRODUCT IS PROVIDED FOR EVALUATION, AS IS
  96.                  AND WITHOUT WARRANTY OF ANY KIND.  THE AUTHOR
  97.                  MAKES NO EXPRESS OR IMPLIED WARRANTIES,
  98.                  INCLUDING BUT NOT LIMITED TO MERCHANTABILITY
  99.                  OR FITNESS FOR ANY PURPOSE.  IN NO EVENT SHALL
  100.                  THE AUTHOR BE LIABLE FOR LOSS OF PROFIT OR ANY
  101.                  OTHER COMMERCIAL DAMAGE ARISING FROM EITHER
  102.                  THE USE OF OR THE INABILITY TO USE THIS PRODUCT.
  103.  
  104.  
  105.  
  106.         ____________________________________________________________
  107.  
  108.              EVALUATION PREFACE                              PAGE
  109.         ____________________________________________________________
  110.  
  111.              Shareware.................................... Pref-1
  112.                License Terms.............................. Pref-2
  113.                Registration............................... Pref-2
  114.                  Forms and Fees........................... Pref-2
  115.                  Quantity discounts....................... Pref-3
  116.  
  117.              Evaluation Version........................... Pref-3
  118.                Distribution Authorization................. Pref-3
  119.                Evaluation Menu............................ Pref-4
  120.                Virus Concerns............................. Pref-4
  121.  
  122.  
  123.  
  124.         █▌ SHAREWARE
  125.  
  126.           "Shareware" is a software distribution method which enables the
  127.           potential user to obtain software at very low initial cost, for
  128.           evaluation on a trial basis.
  129.  
  130.           You can evaluate the software in your own environment, on your
  131.           own machine, with the programs and data that you normally use.
  132.           You're not required to become a registered user unless the
  133.           software meets your needs.
  134.  
  135.           Another benefit of Shareware is lower pricing.  By keeping the
  136.           marketing and advertising expenses to a minimum, Shareware
  137.           products can be priced lower.  You don't pay for what you
  138.           don't need or use.
  139.  
  140.                                                                     Pref-2
  141.  
  142.  
  143.         █▌ LICENSE TERMS
  144.  
  145.           This product and its documentation are copyrighted and owned
  146.           solely by the author, who reserves all rights to any benefits
  147.           derived from it.  It is distinctly separate from, and should not
  148.           be confused with, those categories of software known as "public
  149.           domain" or "freeware."
  150.  
  151.           You are granted the right to use the evaluation version of this
  152.           software on a trial basis for a limited amount of time, to
  153.           decide whether to continue using (and therefore whether to
  154.           register) the product.  You can share the evaluation version of
  155.           this software with others, so long as the limitations set forth
  156.           in the DISTRIBUTION AUTHORIZATION section below are followed.
  157.  
  158.  
  159.  
  160.  
  161.         █▌ REGISTRATION
  162.  
  163.           When you send in the registration form and fee, you'll receive
  164.           by return mail a diskette containing the latest REGISTERED
  165.           VERSION of the program and documentation.  It will NOT include
  166.           the Evaluation Menu front end of this version.  Thus it will be
  167.           easier to use, from either the DOS prompt or from batch files,
  168.           and will also be 12K-15K bytes smaller, for more efficient disk
  169.           storage and faster loading.  The registered version WILL include
  170.           any new functions or enhancements made to date.
  171.  
  172.           As a registered user, you can upgrade to newer versions whenever
  173.           they become available, for a total cost of 50 percent of the
  174.           then-current registration fee.
  175.  
  176.  
  177.  
  178.           REGISTRATION FORM and FEES
  179.  
  180.             The registration form and a pre-addressed mailing cover can be
  181.             printed from the "Forms Printing" selection of the Evaluation
  182.             menu, discussed below.
  183.  
  184.             The single-quantity registration fee is displayed on the
  185.             Evaluation Menu screen.  Each registered copy will be licensed
  186.             for operation at a single location (on a single terminal or
  187.             computer) at any one time.  To use the software on more than
  188.             one terminal or computer at the same time, the appropriate
  189.             number of registrations must be made.
  190.  
  191.                                                                     Pref-3
  192.           REGISTRATION continued
  193.  
  194.  
  195.             Multiple-quantity registration fees are displayed in the
  196.             "QUANTITY DISCOUNT" section of the Evaluation menu.
  197.  
  198.             You can take advantage of quantity discounts by ordering
  199.             multiple registrations of one program or of several different
  200.             programs at the same time.  You also save on shipping and
  201.             handling charges by registering several products together.
  202.  
  203.  
  204.  
  205.  
  206.         █▌ EVALUATION VERSION
  207.  
  208.           This software contains the complete and fully functional version
  209.           of the program, the latest available at the time of this
  210.           release.
  211.  
  212.           The program itself is identical to the REGISTERED version. For
  213.           evaluation, a front end menu containing a documentation file
  214.           viewer and forms printer have been added to ensure that:
  215.             (a)   Registration information and forms will not become
  216.                   separated from the program file.
  217.             (b)   Users who might be unfamiliar with the process of
  218.                   displaying a file's contents on the screen or printer
  219.                   will have no difficulty learning about, evaluating or
  220.                   registering this product.
  221.  
  222.  
  223.  
  224.  
  225.         █▌ DISTRIBUTION AUTHORIZATION
  226.  
  227.           Shareware catalog/disk distributers, Online services, Bulletin
  228.           Board systems, user groups and private individuals are
  229.           authorized to distribute the evaluation version of this software
  230.           by any convenient means, so long as the program, documentation
  231.           and any associated files are distributed together and unaltered.
  232.  
  233.                                                                     Pref-4
  234.  
  235.         █▌ EVALUATION MENU
  236.  
  237.           The program is invoked from the DOS prompt by typing its name
  238.           and pressing the RETURN/ENTER key.  An initial screen displays
  239.           warranty and program information, then the Shareware Product
  240.           EVALUATION MENU with the following functions:
  241.  
  242.               ESC - EXIT to DOS
  243.                R  - READ the documentation (THIS file)
  244.                x  - EVALUATE this program
  245.                Q  - QUANTITY Discount information
  246.                F  - FORMS printing menu - registration & mailer
  247.  
  248.           "R" displays this file one screen at a time, and prompts...
  249.  
  250.               <DownArrow> or Esc
  251.  
  252.           <DownArrow> indicates more is available, similar to the "MORE"
  253.           prompt in other DOS utilities.  Press a normal typing key such
  254.           as the spacebar to continue, or the ESCape key to return to the
  255.           Evaluation Menu.
  256.  
  257.  
  258.  
  259.  
  260.         █▌ VIRUS CONCERNS
  261.  
  262.           If you'd like to evaluate this software but you're not sure
  263.           where it's been, order a copy directly from the source.  See
  264.           the SHAREWARE PRODUCT CATALOG at the end of this file or in
  265.           a separate CATALOG.TXT file.
  266.  
  267.  
  268.                                                                  PhIndex-1
  269.  
  270.  
  271.         █▌ NEW IN THIS VERSION
  272.  
  273.           Dash characters are no longer stripped out.
  274.           Each index word's page number is now written to the output file.
  275.  
  276.  
  277.  
  278.  
  279.         █▌ INTRODUCTION
  280.  
  281.           An "index" is...
  282.  
  283.             A list (usually in alphabetic order) of subjects or keywords.
  284.  
  285.             In a written work, a list of items that includes the location
  286.             where each item may be found.
  287.  
  288.             Short bodies of text, which are intended to be displayed
  289.             electronically rather than on paper, seldom need an index. You
  290.             can easily locate keywords in the text with a file reader/text
  291.             editor having search capability.
  292.  
  293.             An index becomes useful in longer works.  In printed
  294.             documentation, it provides a list of items and their locations
  295.             for manual lookup.  In works designed for on-screen viewing,
  296.             the index can be used in the same manner, or it can be used as
  297.             a list of possible keywords for electronic searches.
  298.  
  299.  
  300.  
  301.  
  302.         █▌ OVERVIEW
  303.  
  304.           This product reads an input file and writes a list of possible
  305.           index words to an output file with extension ".RAW".  The input
  306.           file is retained and is not modified in any way.
  307.  
  308.           The primary purpose of PhINDEX is to process pure ASCII
  309.           (American Standard Code for Information Interchange) text files,
  310.           but it will handle any file type.  Thus, it can also be used to
  311.           generate lists of text words contained in .EXE and .COM files.
  312.  
  313.           PhINDEX does the following:
  314.  
  315.             Ignores all control, digit and extended ASCII characters,
  316.             and almost all punctuation, leaving only apostrophes (used
  317.             in contractions), dashes (used in hyphenation), and upper
  318.             and lower case alphabetic characters.
  319.  
  320.             Ignores all words shorter than a minimum length.  Default
  321.             minimum length is 3 characters; an alternate value of 1
  322.             through 20 can be specified on the command line.
  323.  
  324.  
  325.                                                                  PhIndex-2
  326.           OVERVIEW - continued
  327.  
  328.  
  329.             Ignores trivial or "noise" words that are not likely to be
  330.             useful in an index.
  331.  
  332.             Writes each remaining word, with its page number, to a
  333.             separate line in the output file.  Page numbering is
  334.             controlled by formfeed characters (Ctrl-L, ASCII 12
  335.             decimal) in the input file; if the input contains no
  336.             formfeeds, every word is assigned a page number of 1.
  337.  
  338.             Case is not modified.
  339.  
  340.             The output file must be processed further to create
  341.             a complete index; see the INDEX PROCEDURE section below.
  342.  
  343.  
  344.  
  345.         █▌ SYSTEM REQUIREMENTS
  346.  
  347.           PC, XT, AT or compatible.
  348.           DOS version 2.1 or later.
  349.  
  350.  
  351.  
  352.         █▌ INSTALLING
  353.  
  354.           The program can be run from diskette or from hard disk.  No
  355.           installation is necessary, other than copying the files to a
  356.           drive and directory of your choosing.  To run the program from
  357.           other than its resident drive or directory, specify its location
  358.           with the DOS PATH statement.
  359.  
  360.  
  361.  
  362.         █▌ HELP
  363.  
  364.           Can't remember the command line syntax?
  365.           Issue the program's name without any parameters; it will
  366.           display a help screen, then return to the DOS prompt.
  367.  
  368.  
  369.                                                                  PhIndex-3
  370.  
  371.         █▌ SYNTAX
  372.  
  373.  
  374.               PhINDEX [filespec] [/min word length for output]
  375.  
  376.           Where...
  377.  
  378.             [/min word length] is an optional minimum word length.
  379.                 Allowable values are 1 through 20.
  380.                 Default is 3.
  381.  
  382.                 All words found with this length or longer, if not noise
  383.                 words, will be written to the output file. All shorter
  384.                 words will be discarded.
  385.  
  386.             [filespec] is the string needed to reference a file;
  387.                 can also be shown as [d:][path][filename.ext].
  388.  
  389.                 The minimum filespec needed is filename.ext.  If the file
  390.                 is in another directory and/or on another drive, the drive
  391.                 name and/or path name must also be given.
  392.  
  393.                 The complete filespec for a file named ThisFile.Doc
  394.                 residing in drive A: in a subdirectory named ThisSub is
  395.  
  396.                         A:\ThisSub\ThisFile.Doc
  397.  
  398.                 For further information on filespecs, see your DOS manual.
  399.  
  400.  
  401.  
  402.         █▌ EXAMPLES
  403.  
  404.           PhINDEX userdoc.txt /1
  405.  
  406.               Reads userdoc.txt in default drive and directory, then
  407.               writes index list to userdoc.RAW in the same drive and
  408.               directory.  All words of 1 or more characters are listed.
  409.  
  410.           PhINDEX b:\manuals\userdoc.txt
  411.  
  412.               Reads userdoc.txt in b:\manuals, writes index list to
  413.               userdoc.RAW in the current (default) drive and directory.
  414.               Since no /option is specified, all words of 3 or more
  415.               characters are listed.
  416.  
  417.  
  418.                                                                  PhIndex-4
  419.  
  420.         █▌ OPERATING SCREEN
  421.  
  422.           The operating screen appears whenever "PhINDEX" is issued from
  423.           the DOS prompt (or from a batch file) with a file spec. This
  424.           example is run from C:\WORK with a command line of:
  425.  
  426.               PhINDEX c:\manuals\userdoc.txt
  427.  
  428.           and the screen displays:
  429.  
  430.                __PhINDEX_____________________
  431.               |______________________________|
  432.               C:\MANUALS\USERDOC.TXT   20000 bytes
  433.               Writing words of 3 or more chars to C:\WORK\USERDOC.RAW
  434.               [] [] [] [] [] [] []
  435.                               \
  436.                                Activity indicator blocks
  437.  
  438.  
  439.  
  440.  
  441.         █▌ NOISE WORDS
  442.  
  443.           PhINDEX automatically rejects certain words, regardless of the
  444.           specified minimum word length.  The list currently contains 72
  445.           words:
  446.  
  447.               A ALL AM AN AND ANY ARE BE BEEN BUT BY CAN DID DO
  448.               FOR FROM GET GO HAD HAS HAVE HE HER HERE HIM HOW
  449.               IF IN INTO IS IT ITS JUST LIKE ME MY NO NOT NOW
  450.               OF ON ONLY OR SEE SO SOME SUCH THAN THAT THE THEM
  451.               THEN THERE THESE THEY THIS THOSE TO TOO US USE
  452.               WAS WE WERE WHAT WHEN WHERE WHO WHY WITH YOU YOUR
  453.  
  454.  
  455.  
  456.  
  457.         █▌ EXECUTION SPEEDS
  458.  
  459.           Times are from a 4.77mhz XT-compatible system, with input and
  460.           output files residing on hard disk.  SORT is the sorting utility
  461.           supplied with DOS.
  462.  
  463.               Input file  - 20,000 bytes, 2224 words,  603 lines.
  464.               Output file - 15,626 bytes, 1355 words, 1344 lines.
  465.  
  466.                Command line                 Elapsed time
  467.               --------------------------   --------------
  468.                PhINDEX Test.Txt              27 seconds
  469.                SORT <Test.RAW >Test.IND     133 seconds
  470.  
  471.  
  472.                                                                  PhIndex-5
  473.  
  474.         █▌ INDEX PROCEDURE
  475.  
  476.  
  477.           Steps in compiling an index of documentation stored
  478.           in a file named Manual.Txt:
  479.  
  480.             1-- Compile a list of all significant words of 3 or more
  481.                 characters in the documentation file:
  482.  
  483.                     PhINDEX Manual.Txt
  484.  
  485.                 The resulting raw list is stored in Manual.RAW.
  486.  
  487.             2-- Edit the unsorted list in Manual.RAW.
  488.  
  489.                 Combine words from key phrases or concepts in the original
  490.                 text into multi-word entries, before their relative
  491.                 locations are changed by sorting.
  492.  
  493.                 Make finding topics easier by adding synonyms, and by
  494.                 adding entries to cover each word in multi-word entries.
  495.                 For example, the original entry
  496.  
  497.                     "Registration form"
  498.  
  499.                 could be supplemented with another entry,
  500.  
  501.                     "form, Registration".
  502.  
  503.                 To convert to a paragraph- or section-numbered index,
  504.                 use the page numbers to locate sections in the original
  505.                 documentation, then change the index page numbers to
  506.                 section numbers.
  507.  
  508.             3-- Sort the raw list into alphabetic order using the DOS SORT
  509.                 utility.  The following command line directs Manual.RAW
  510.                 into SORT, and the output to Manual.IND:
  511.  
  512.                     SORT <Manual.RAW >Manual.IND
  513.  
  514.                 The resulting sorted list is stored in Manual.IND.
  515.  
  516.             4-- Edit the sorted list in Manual.IND:
  517.  
  518.                 Sorting will have grouped duplicate words or phrases
  519.                 together.  Consolidate their page or section numbers into
  520.                 one main entry, then delete duplicate entries.
  521.  
  522.                 Referring to the original text file and the raw word list,
  523.                 decide which lines in the sorted list should stand alone
  524.                 and which should be made sub-entries of others (if any).
  525.  
  526.  
  527.                                                                  PhIndex-6
  528.  
  529.         █▌ SAMPLE RUN
  530.  
  531.           An example from indexing a 3-page document file:
  532.  
  533.               Manual.RAW               Manual.RAW after some
  534.                unsorted                 words are combined
  535.             ---------------------    -------------------------
  536.               DISCLAIMER 1             DISCLAIMER of WARRANTY 1
  537.               WARRANTY 1               Warranty disclaimer 1
  538.               EVALUATION 1             EVALUATION PREFACE 1
  539.               PREFACE 1
  540.               SHAREWARE 1              SHAREWARE distribution 1
  541.               distribution 1
  542.               lower 1
  543.               advertising 1            advertising expences 1
  544.               expenses 1
  545.               traditional 1            traditional distribution 1
  546.               software 1
  547.               distribution 1
  548.               Shareware 1              Shareware products 1
  549.               products 1
  550.               LICENSE 2                LICENSE TERMS 2
  551.               TERMS 2
  552.               evaluation 2             evaluation version 2
  553.               version 2
  554.               trial 2                  trial basis 2
  555.               basis 2
  556.               limited 2                limited time 2
  557.               time 2
  558.               REGISTRATION 2           REGISTRATION form 2
  559.               form 2                   form, Registration 2
  560.               REGISTERED 2             REGISTERED VERSION 2
  561.               VERSION 2
  562.               efficient 2
  563.               disk 2                   disk storage 2
  564.               storage 2
  565.               upgrade 2                upgrade 2
  566.               newer 2                  newer versions 2
  567.               versions 2
  568.               EVALUATION 3             EVALUATION VERSION 3
  569.               VERSION 3
  570.               evaluation 3             evaluation front end 3
  571.               front 3
  572.               end 3
  573.               documentation 3          documentation file 3
  574.               file 3                   file viewer 3
  575.               viewer 3
  576.               forms 3                  forms 3
  577.               printer 3                printer 3
  578.               DISTRIBUTION 3           DISTRIBUTION AUTHORIZATION 3
  579.               AUTHORIZATION 3
  580.               Online 3                 Online services 3
  581.               services 3
  582.  
  583.  
  584.                                                                  PhIndex-7
  585.           SAMPLE RUN - continued
  586.  
  587.  
  588.           Here's the interim result after adding more detail, then sorting
  589.           the index into Manual.IND.  The index still contains duplicate
  590.           entries that should be combined, and entries that could be
  591.           expanded or deleted.
  592.  
  593.  
  594.               advertising expenses 1
  595.               Authorization, distribution 3
  596.               DISCLAIMER of WARRANTY 1
  597.               disk storage 2
  598.               DISTRIBUTION AUTHORIZATION 3
  599.               distribution, software 1
  600.               distribution, traditional 1
  601.               documentation file 3
  602.               efficient 2
  603.               evaluation front end 3
  604.               EVALUATION PREFACE 1
  605.               evaluation version 2
  606.               EVALUATION VERSION 3
  607.               expenses, advertising 1
  608.               file viewer 3
  609.               form, Registration 2
  610.               forms 3
  611.               front end, evaluation 3
  612.               LICENSE TERMS 2
  613.               limited time 2
  614.               lower 1
  615.               newer versions 2
  616.               Online services 3
  617.               preface 1
  618.               printer 3
  619.               REGISTERED VERSION 2
  620.               REGISTRATION form 2
  621.               services, Online 3
  622.               SHAREWARE distribution 1
  623.               Shareware products 1
  624.               software 1
  625.               Terms, license 2
  626.               time, limited 2
  627.               traditional distribution 1
  628.               trial basis 2
  629.               upgrade 2
  630.               version, Evaluation 3
  631.               version, newer 2
  632.               viewer, file 3
  633.               Warranty disclaimer 1
  634.  
  635.  
  636.  
  637.                                                                  PhIndex-8
  638.           SAMPLE RUN - continued
  639.  
  640.  
  641.           Here's the final version of Manual.IND after removing duplicate
  642.           entries, combining lines, and making some lines sub-entries of
  643.           others.  Many entries have been augmented with further detail
  644.           from other lines.
  645.  
  646.               Keyword Index
  647.             --------------------------------
  648.               advertising expenses 1
  649.               Authorization, distribution 3
  650.               DISCLAIMER of WARRANTY 1
  651.               disk storage 2
  652.               DISTRIBUTION
  653.                   AUTHORIZATION 3
  654.                   software 1
  655.                   traditional 1
  656.               documentation file 3
  657.               evaluation
  658.                   front end 3
  659.                   PREFACE 1
  660.                   version 2,3
  661.               expenses, advertising 1
  662.               file viewer 3
  663.               form, Registration 2
  664.               forms 3
  665.               front end, evaluation 3
  666.               LICENSE TERMS 2
  667.               limited time 2
  668.               newer versions 2
  669.               Online services 3
  670.               preface, evaluation 1
  671.               REGISTERED VERSION 2
  672.               REGISTRATION form 2
  673.               services, Online 3
  674.               SHAREWARE
  675.                   distribution 1
  676.                   products 1
  677.               software 1
  678.               storage, disk 2
  679.               Terms, license 2
  680.               time, limited 2
  681.               traditional distribution 1
  682.               trial basis 2
  683.               upgrade 2
  684.               version
  685.                   Evaluation 3
  686.                   newer 2
  687.               viewer, file 3
  688.               Warranty disclaimer 1
  689.  
  690.  
  691.                                                                  PhIndex-9
  692.  
  693.         █▌ DOS ERRORLEVEL
  694.  
  695.           Upon termination, the program returns a DOS ErrorLevel value
  696.           which indicates how the program ended, and which can be used for
  697.           subsequent operations in a batch file.  For further information,
  698.           see the "IF ERRORLEVEL" batch command in your DOS manual.
  699.  
  700.           ErrorLevel List:
  701.  
  702.             0  -  Successful completion.
  703.             1  -  No parameters specified on command line.
  704.             2  -  Too many parameters on command line.
  705.             3  -  /option not recognized - must be numeric.
  706.             4  -  /option out of range.
  707.             5  -  Input file not found.
  708.             6  -  Illegal input file extension - rename.
  709.             7  -  Cannot open input file.
  710.             8  -  Cannot create output file.
  711.  
  712.  
  713.  
  714.         █▌ VERSION HISTORY
  715.  
  716.           1.00  Initial release.
  717.  
  718.           1.1   Added automatic stripping of short words (length
  719.                 selectable) and a number of trivial "noise" words.
  720.  
  721.           1.2   Apostrophe characters are retained, so contractions will
  722.                 be correct in output file (words like "haven't" are no
  723.                 longer shortened to "haven").
  724.  
  725.                 Changed output destination to current (default) path.
  726.                 Modified display of input and output filenames to
  727.                 include full drive and path information.
  728.  
  729.           1.3   Dash characters are retained, so hyphenated words
  730.                 won't be split up in the output file.
  731.  
  732.                 Each index word's page number is now written to the
  733.                 output file.
  734.  
  735.  
  736.  
  737.                                                                        A-1
  738.  
  739.         █▌ SUPPORT
  740.  
  741.           The first user to document and report a problem that we agree
  742.           needs attention, will be sent a free upgrade with the correction
  743.           when it's been made.  Registered users will receive an upgraded
  744.           registered version; unregistered evaluators receive an upgraded
  745.           evaluation version.
  746.  
  747.  
  748.         █▌ PROBLEM RESOLUTION
  749.  
  750.           Things to try prior to reporting a problem:
  751.  
  752.             1 - Reread the documentation to make sure you understand
  753.                 what we thought we understood when we wrote it.
  754.  
  755.             2 - If the system reports "Bad command or file name" when you
  756.                 attempt to run the program, its executable file (or at
  757.                 least the file name you specified) was not found.
  758.  
  759.                 First, make sure no typos or misspellings have crept into
  760.                 the command line; next, try changing the PATH setting, or
  761.                 make the drive & directory where the program resides the
  762.                 "current" drive & directory.
  763.  
  764.             3 - If the program is being run from a batch file, try
  765.                 deleting lines previous to the line that actually invokes
  766.                 the program, to see if some prior activity is causing the
  767.                 problem.
  768.  
  769.             4 - If memory-resident or "TSR" utilities (pop-up note pads,
  770.                 calculators, keyboard enhancements, etc.) are installed,
  771.                 try removing them from memory and running the program
  772.                 again to see if the problem reoccurs.
  773.  
  774.  
  775.         █▌ REPORTING A PROBLEM
  776.  
  777.           If the problem persists, please document it as thoroughly as
  778.           possible; we must be able to duplicate it before we can begin to
  779.           resolve it.  Include at least the following:
  780.  
  781.             1 - Problem program's name and version number.
  782.             2 - Where and how you obtained the problem program.
  783.             3 - Address and/or phone number where you can be contacted.
  784.             4 - Version of DOS you are using.
  785.             5 - Machine type, drives, memory, etc.
  786.             6 - Programs executed prior to the problem.
  787.             7 - Anything that might relate to the problem; for example,
  788.                 listings of your AUTOEXEC.BAT and CONFIG.SYS files, or
  789.                 any batch files used to run the program.
  790.             8 - Any relevant printouts.
  791.  
  792.                                                                        A-2
  793.           REPORTING A PROBLEM continued
  794.  
  795.  
  796.           NOTE: Registered users receive the utility UserResp.Exe
  797.                 on the distribution diskette; it can be used to
  798.                 print a pre-addressed mailer and a problem report.
  799.  
  800.  
  801.  
  802.  
  803.  
  804.  
  805.         █▌ CUSTOM MODIFICATIONS
  806.  
  807.           If custom modifications to this software are needed for your
  808.           particular application, please write to the below address with
  809.           complete details of your requirements.
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.         █▌ CORRESPONDENCE
  817.  
  818.           We welcome any comments or suggestions you might have concerning
  819.           improvements and future enhancements to this product.  Send all
  820.           correspondence and orders to:
  821.  
  822.                                    Phil Herron
  823.                                   P.O. Box 1288
  824.                       Battle Ground, Washington  USA  98604
  825.  
  826.                                                                        I-1
  827.  
  828.         █▌ INDEX
  829.  
  830.  
  831.           .RAW extension 1,5               INSTALLING 2
  832.           /option 3                        INTRODUCTION 1
  833.           Activity indicator 4             key concepts 5
  834.           alphabetic order 1,5                 phrases 5
  835.           American Standard Code 1             words 1
  836.           Apostrophe 1,9                   longer works 1
  837.           ASCII 1,2                        Minimum word length 1,3,4
  838.           case, upper/lower 1,2            multi-word entries 5
  839.           combining lines 8                NEW in this VERSION 1
  840.           command line 1,2,4,5             noise words 2,3,4
  841.           compiling an index 5             OPERATING SCREEN 4
  842.           contractions 1,9                 output file 1,2,3,4,9
  843.           control chars 1                  OVERVIEW 1
  844.           Ctrl-L 2                         page numbering 1,2,5
  845.           Dash chars 1,9                   page-numbered 5
  846.           default path 9                   paragraph-numbered 5
  847.           digit chars 1                    path 3,9
  848.           display, screen 4                PROCEDURE, INDEX 5
  849.               text, electronic 1           punctuation 1
  850.           DOS ERRORLEVEL 9                 RAW extension 5
  851.               PATH 2                           word list 5
  852.               prompt 2,4                   running PhINDEX 5
  853.               SORT utility 5               SAMPLE RUN 6
  854.               version 2                        final result 8
  855.           duplicate entries 7,8                sorted 7
  856.               deleting 5                   search 1
  857.               words, phrases 5             section-numbered 5
  858.           Editing 5                        significant words 5
  859.           Elapsed time 4                   SORT, list 4,5
  860.           entries, multi-word 5            sorted list editing 5
  861.           ErrorLevel 9                     Speed of execution 4
  862.           EXAMPLES, command line 3         strip words 1,2
  863.           EXECUTION SPEEDS 4               sub-entries 5,8
  864.           extended ASCII 1                 synonyms 5
  865.           extension, .RAW 1,5              SYNTAX 3
  866.           file reader 1                    SYSTEM REQUIREMENTS 2
  867.                type 1                      termination, program 9
  868.                text 1                      text editor 1
  869.           filename & ext 3                 time, execution 4
  870.           filespec 3,4                     trivial words 2
  871.           finding topics easier 5          unsorted list 5
  872.           formfeed chars 2                 VERSION HISTORY 9
  873.           HELP, screen 2                   viewing on screen 1
  874.           hyphen 1,9                       word length, Default 1,3
  875.           index compiling 5                     length, minimum 1
  876.                 definition 1                    strip 1
  877.                 PROCEDURE 5                words, significant 5
  878.           input file 1,2,4
  879.                                               Shareware Product Catalog -1
  880.  
  881.  
  882.          ______________________________________________________________
  883.         |                                                              |
  884.         |                - SHAREWARE PRODUCT CATALOG -                 |
  885.         |______________________________________________________________|
  886.  
  887.  
  888.         Evaluation versions of our products are available from many
  889.         Shareware distributors and user groups; latest versions can
  890.         also be ordered directly from us (see order form following)
  891.         or downloaded by modem from CompuServe Information Service.
  892.  
  893.                  ____________________________________________
  894.  
  895.                  PROGRAM SPECIFICATIONS AND REGISTRATION FEES
  896.                            MAY CHANGE WITHOUT NOTICE
  897.                  ____________________________________________
  898.  
  899.  
  900.         1099 Series - IRS forms preparation
  901.              1099M  - 1099-MISC Miscellaneous income statement
  902.              1099i  - 1099-INT  Interest income statement
  903.              1099S  - 1099-S    Real Estate Transactions statement
  904.              1098   - 1098      Mortgage Interest statement
  905.  
  906.         Account_SoRT
  907.           ASRT sorts user-entered data into categories.  In business and
  908.           tax accounting, it accumulates monetary units in financial
  909.           accounts.  Multiple user-designed charts of accounts for any
  910.           number of businesses.  User-selectable limit checking.
  911.  
  912.         CHeck_Disk_space
  913.           ChkD reports disk drive space usage: cluster size, then drive
  914.           space TOTAL, FREE and USED by actual value and by percentage.
  915.           Faster and more convenient than the DOS "dir" or "chkdsk"
  916.           utilities.  For batch file branching, returns Dos ErrorLevel
  917.           corresponding to the % of space available.
  918.  
  919.         CHeck_Memory_space
  920.           ChkM reports standard system memory (RAM) space usage: memory
  921.           space TOTAL, FREE and USED by actual value and by percentage.
  922.           Faster and more convenient than the DOS "chkdsk" utility.  For
  923.           batch file branching, returns Dos ErrorLevel corresponding to
  924.           the % of space available.
  925.  
  926.         CHeck_Space
  927.           ChkSp reports free space available in system RAM and on
  928.           specified or default drive.  Displays actual amounts along
  929.           with bargraphs of the percentages of total space.
  930.  
  931.  
  932.  
  933.                                               Shareware Product Catalog -2
  934.  
  935.  
  936.         CleanOut
  937.           Searches all directories for specified files, prompts for
  938.           Delete or Save of each match found.  File contents (text OR
  939.           binary) can be viewed first.  Single "S" key saves; double "D"
  940.           key deletes.  Optional mode for cleanout without confirmation.
  941.           Useful for quick disposal of .BAK file leftovers, among others.
  942.  
  943.         Clean_Text
  944.           CleanTxt converts WordStar text files to straight ASCII.  It
  945.           strips out certain control characters, and will optionally
  946.           expand tab characters to the appropriate number of spaces.
  947.  
  948.         CleanZ
  949.           Most editors don't read files beyond the first control- Z
  950.           end-of-file character.  Control-Z's can become embedded in a
  951.           text file when several files are combined using the DOS "type"
  952.           command.  CleanZ strips out each control-Z, or will optionally
  953.           replace each with a seldom-used character, to ease the task of
  954.           locating the former boundaries in combined files.
  955.  
  956.         Cursor_Set
  957.           CurSet changes the shape of the text cursor.  Makes the cursor
  958.           easier to find on Liquid Crystal displays used in laptop/
  959.           notebook computers; works with any display.  Both command line
  960.           and interactive modes for setting the cursor to any shape from
  961.           a hairline to a full block.
  962.  
  963.         Diskette_Initialize
  964.           DiskInit erases all files and subdirectories on a 5.25 inch
  965.           362k DSDD diskette in about two seconds.  Does not initialize
  966.           marked bad sectors, but suggests reformatting instead.
  967.  
  968.         Error_Level
  969.           ErrLev is a utility for testing batch file "if errorlevel"
  970.           statements.  During testing, executable program calls are
  971.           commented out and replaced with "ErrLev nn", where nn is the
  972.           DOS errorlevel to be simulated.  The simulated errorlevel then
  973.           exercises branching commands in the batch file under test.
  974.  
  975.         Find_Directory
  976.           FindD searches the default drive for specified subdirectory
  977.           names, and lists the complete path to those found.
  978.  
  979.         Find_File
  980.           FindF searches the default drive for specified files, and
  981.           writes the file information to screen or disk. Useful for
  982.           locating misplaced files or for generating a listing of all
  983.           files and subdirectories on the default drive.
  984.  
  985.  
  986.  
  987.  
  988.                                               Shareware Product Catalog -3
  989.  
  990.  
  991.         FREQuency_of_CHaracters
  992.           FreqCh performs letter-frequency analysis of text or binary
  993.           files; handles the full 256-character extended Ascii set.
  994.           Results are sorted in Ascii code order or frequency of
  995.           occurrence.
  996.  
  997.         GENerate_file
  998.           Gen builds disk files of 0 to over 2 Gbytes using either
  999.           character mode or much faster file mode.  Can also send
  1000.           characters directly to the console screen, printer or other
  1001.           DOS device.  Useful for printer, storage and timing tests.
  1002.  
  1003.        KeyCode
  1004.           Responds to each press of a key or combination of keys by
  1005.           displaying the key or combination pressed, its associated
  1006.           Ascii character (if any), key type (normal or extended),
  1007.           Ascii code and Scan code.
  1008.  
  1009.         KeySet
  1010.           Interactive mode displays the current settings of the
  1011.           CapsLock, NumLock, ScrollLock and PrtSc (Print Screen) keys,
  1012.           and allows changing them.  Command line mode directly sets
  1013.           the keys to specified states, allowing use of a batch file
  1014.           for presetting at system boot-up or between applications.
  1015.  
  1016.         PhIndex
  1017.           Removes some of the drudgery from generating documentation
  1018.           indexes.  Reads an ASCII text file, ignores most punctuation,
  1019.           digits, trivial "noise" words and words shorter than a
  1020.           specified minimum, then writes output to disk file, one word
  1021.           per line, with page number.  User edits to consolidate dups
  1022.           and include phrases/concepts, then sorts with DOS Sort utility.
  1023.           Complete documentation and examples included.
  1024.  
  1025.         PhLabel
  1026.           Label/Rotary filecard/Postcard Printer; loads, displays,
  1027.           prints labels stored in easily-maintained ASCII files.
  1028.           Optional embedded commands for date, time, margin, selectable
  1029.           printer attributes; 5, 8.5, 10, 12, 17 or 20 characters per
  1030.           inch pitch, normal/bold/underlined on Epson compatible
  1031.           dot-matrix printers.
  1032.  
  1033.         PRINter_TEST
  1034.           PrinTest repetitively displays the status of ports assigned to
  1035.           parallel printer interfaces.  Can be used to isolate problems
  1036.           to the printer interface card, the cable or the printer itself.
  1037.           Reports printer & port number, status byte & condition.
  1038.  
  1039.  
  1040.  
  1041.                                               Shareware Product Catalog -4
  1042.  
  1043.  
  1044.         Quick_SCReen
  1045.           Qscr converts a single text screen to an executable file.  The
  1046.           resulting .COM file displays a screen of text much faster than
  1047.           batch file ECHO statements.  Useful for setting up compact
  1048.           menu systems, demos and tutorials.
  1049.  
  1050.         SCAN_File
  1051.           ScanF speeds up the search for ASCII text strings within
  1052.           executable files.  Filters out the unintelligible control
  1053.           and extended characters, and allows user definition of
  1054.           minimum string length for display.
  1055.  
  1056.         SCAN_Memory
  1057.           ScanM speeds up the search for ASCII text such as ROM
  1058.           copyright statements and machine identification, anywhere
  1059.           within standard system memory space.  Filters out the
  1060.           unintelligible control and extended characters, and
  1061.           displays each string longer than three characters.
  1062.  
  1063.         SPLIT_file
  1064.           Split breaks huge text files down into smaller ones that will
  1065.           fit into a text editor or onto a diskette.  Useful for working
  1066.           on large files with a limited filesize memory- resident
  1067.           notepad utility.
  1068.  
  1069.         SSN_lookup
  1070.           Social Security Number Prefix/Location Lookup
  1071.  
  1072.         STOrage_RooM
  1073.           StoRm reports disk space required for storage of a specified
  1074.           file or group of files on any disk, any DOS version. Locates
  1075.           files specified on command line, determines their actual total
  1076.           size and the amount of room needed to store them.  Useful for
  1077.           determining the number of files that will fit on a disk.
  1078.  
  1079.         ZipCODE_prefix_lookup
  1080.           Postal Zip Code Number Prefix/Location Lookup
  1081.  
  1082.  
  1083.                                               Shareware Product Catalog -5
  1084.  
  1085.  
  1086.         Evaluation Version ORDER FORM 1091             Date __________________
  1087.         ----------------------------------
  1088.         Mailing address of individual or organization:
  1089.  
  1090.         Contact/Name _________________________________________________________
  1091.  
  1092.          Org/Address _________________________________________________________
  1093.  
  1094.              Address _________________________________________________________
  1095.  
  1096.                 City ___________________________ State/Prov __________________
  1097.  
  1098.             Country  ______________________________ ZipCode __________________
  1099.  
  1100.         Each disk holds up to five programs and associated documentation.
  1101.         Include $6.00 for the first disk, shipping & handling.  Add $2 for
  1102.         each additional disk of programs you want to evaluate (Example:
  1103.         $6 for 1-5 programs, $8 for 6-10, $10 for 11-15, etc.).
  1104.  
  1105.         ******  Evaluation Pgm Names (up to 5 per disk) **************  Price
  1106.  
  1107.         ___________  ___________  ___________  ___________  ___________ $6.00
  1108.  
  1109.         ___________  ___________  ___________  ___________  ___________ $2.00
  1110.  
  1111.         ___________  ___________  ___________  ___________  ___________ $2.00
  1112.  
  1113.         ___________  ___________  ___________  ___________  ___________ $2.00
  1114.  
  1115.         ___________  ___________  ___________  ___________  ___________ $2.00
  1116.  
  1117.         ___________  ___________  ___________  ___________  ___________ $2.00
  1118.  
  1119.         Disk format: 360K DSDD 5.25" only.   EVALUATION DISK TOTAL  $_____.___
  1120.  
  1121.  
  1122.         Outside U.S. & Canada, additional shipping  ......  $6.50   $_____.___
  1123.  
  1124.                                                          SUBTOTAL   $_____.___
  1125.         Sales Tax - WA State residents only: 7.6% of SubTotal ...   $_____.___
  1126.  
  1127.         ****************************************** ENCLOSED TOTAL   $_____.___
  1128.  
  1129.         PAYMENT: Check or Money Order (U.S. funds only).
  1130.                  Purchase Orders must be prepaid.  Sorry, no COD's.
  1131.          _____________________________________________________________
  1132.         |                                                             |
  1133.         |           Send all correspondence and orders to:            |
  1134.         |                                                             |
  1135.         |               Phil Herron                                   |
  1136.         |               P.O. Box 1288                                 |
  1137.         |               Battle Ground, Washington  USA  98604         |
  1138.         |_____________________________________________________________|